home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / mac / util / comm / chat100.sit / Chat 1.0.0 / Chat Documentation next >
Encoding:
Text File  |  1992-04-26  |  9.1 KB  |  132 lines

  1. Chat 1.0.0 ⌐ Peter N Lewis, Mar 1992.
  2. This program is free, but I retain the copyright on it.
  3.  
  4. This program was initially written to assist in the online meetings of the TopSoft group, a group of mac programmers on the Internet, dedicated to producing free, high quality software and sample code.  If this program is of use to you, you could help us out by either joining the group (send mail to topsoft@newton.eng.ohio-state.edu (may change in the future, contact me if it fails)), or  by providing an FTP site, or a machine on which we could set up mailing lists and/or user accounts for redirecting mail.  Any help you could offer us would improve our chances of turning a fledgling group in to the Macintosh equivalent of the Free Software Foundation.
  5.  
  6. Ñ Contents
  7.  
  8.       What Chat Does
  9.       Using Chat
  10.       Customising Chat
  11.       How It Works
  12.       Limitations
  13.       Small Print
  14.       Warranty
  15.       Fine Print
  16.       Version History
  17.       The Author
  18.  
  19. Ñ What Chat Does
  20.  
  21. Chat is a background only application that lets Macs with MacTCP 1.1 serve as a very primitive IRC.  Once Chat is running on your mac, multiple people can Telnet to port 1420 on your mac and have online discussions .  Chat has no macintosh user interface, the only way to use it is by telneting to your mac.  I wrote this to hold the weekly online meetings of the TopSoft group, which have proved very successful.   Chat can support upwards of 12 users with the current memory partition (200k), and can support an arbitrarily large number of users given enough memory (though MacTCP will probably blow up if you try too many :-).  Add about 5 or 10k for each extra users you want.
  22.  
  23. Ñ Using Chat
  24.  
  25. You must have MacTCP 1.1 installed in order to use Chat.
  26.  
  27. Put Chat or an alias to it in the Startup Folder (System 7) or make it a startup application (System 6 - note you will have to use "Selected Applications and DAs" since background only applications are not counted as Open Applications unbder System 6).  Double-Click Chat to get it started now.
  28.  
  29. Now you need to connect to Chat using NCSA/Telnet, MUDDweller, telnet on unix or VMS machines or some other method...
  30.  
  31. NCSA/Telnet:
  32. Choose Open Connection from the File Menu, type in the name (or IP number) of your mac, a space and then the port number (1420).
  33.  
  34. MUDDweller:
  35. Choose New, then choose TCP/IP Address from the configure menu and type in the ip numbers of your mac (or the name for newer versions of MUDDweller), and the port number (1420).  Hit OK, and then choose Open Connection from the Configure menu.
  36.  
  37. Unix:
  38. telnet <macname or ip number> 1420
  39.  
  40. VMS:
  41. telnet <macname or ip number> /port=1420
  42.  
  43. Chat is very boring with only one person logged in, so get someone else to log in as well, or log in yourself several times.  Once you have connected, you will be asked for a name.  This is the name others will see you as when you ╥speak╙.  In our online meetings we use the convention of first name and last initial (Ie, I log in as PeterL), but you can use any name you like.  Once you press return, you will be given a list of people currently logged on.  From now on anything you type will be echoed to all other users in a format like this:
  44.  
  45. I type ╥Hello╙, and others would see:
  46. PeterL: Hello
  47.  
  48. Here is a sample session:
  49.  
  50. unixprompt> telnet mymac 1420
  51. Welcome to Peter's Private Party Line.
  52. Enter your name:PeterL
  53. Welcome, commands are LIST and QUIT, everything else is echoed to all parties.
  54. Warning: Everything said is logged and may be used against you.
  55. list
  56. FredB
  57. Hi Fred, whats up?
  58. FredB: Ahh, fred you showed up.  Nothing much, usual stuff.
  59. FredB: How is Chat coming along?
  60.  
  61. Here, I typed the lines:
  62. telnet mymac 1420
  63. PeterL (third line)
  64. Hi Fred, whats up?
  65.  
  66. Try it out, you╒ll get the idea pretty quick.
  67.  
  68. There are two commands that are not echoed.  LIST (case is irrelevant), which gives you a list of the people currently logged on (this is done automatically when you first log on), and QUIT (case is irrelevant), which logs you off.  There is also a silent command which only the owner should use, QUITNOW (case IS relevant), which closes the server down.  Don╒t use this on someone else╒s server!
  69.  
  70. Ñ Customising Chat
  71.  
  72. You can customise Chat by using ResEdit to change the STR# resource which contains the port number, the Chat Log name (make it an empty string to disable logging), the Chat Log creator, the three commands (QUITNOW, QUIT, LIST), and all the strings that Chat produces.
  73.  
  74. Ñ How It Works
  75.  
  76. Chat is a very simple program, I wrote it in about three hours, plus I've done about three more hours neatifying it, and a couple hours getting it ready to send out.  The entire program (ignoring the TCP and other libraries) is only 350 lines, and as such should be a good starting sample code for writing TCP applications (the pascal source code will be sent out as with all my programs).
  77.  
  78. All it does is listen to the TCP port specified in the STR# resource.  When it gets a new connection it starts up another listener, and deals with the user, first getting their name and then echoing all their messages to the other users.  It does this by keeping a list of all currently logged on users, when a line comes in from one user, it goes thru the list and echoes it (with the user╒s name prepended) to all other users.
  79.  
  80. Ñ Limitations
  81.  
  82. Chat probably require the 128k ROM and System version 6.0 or higher.  It may well only work with a Mac IIsi (not mine)-:, and System 7.0.  It definitely requires MacTCP v1.1 (and may work with higher versions when they come out, but who knows).
  83.  
  84. There are several caveats.  First, you must terminate your lines every 70 characters or so, it doesn╒t word wrap for you (it should, its easy, I just haven╒t done it).  Second, in a ╥crowded room╙, you may have troubles with people all speaking at once (which is not a real problem for users using MUDDweller, but mucks up the screens of users who connect with other clients).  The solution we adopted was to start and end you messages with a blank line, so people can tell when you have finished, and avoid interrupting you once you have started.
  85.  
  86. Ñ Small Print
  87.  
  88. This program is free, don╒t bother sending me any money for this one, it was only a days work anyway.  If you like it, send me an Email message saying hello, or a postcard or something like that.
  89.  
  90. You may distribute Chat any way you wish as long as you don't charge for it (reasonable download costs such as Compu$erve are ok I guess (although who would call Compu$erve's download costs reasonable?)).  It would probably be a good idea to keep this documentation file with the program, but I'm hardly likely to check up on you now am I!  I don't guarantee any support, but I always answer my Email (I'm not so good with snail-mail and those horrible little bits of paper and such!).  If I don't answer Email its because your message didn't get to me, or my reply bounced (so try again, and include a valid Internet address if you can).
  91.  
  92. You MAY NOT distribute it on any magnetic media you charge for without my express permission unless you charge less that US$3 for the disks (and no membership costs).  I am sick and tired of seeing people selling PD/Shareware software for five or ten dollars a disk without any reimbursement to the authors.
  93.  
  94. Ñ Warranty
  95.  
  96.       There is absolutely NO warranty, guarantee, hint, suggestion or anything else that would lead anyone to think that Chat do anything stated in this documentation.  It usually does not destroy data (systems, hardware, etc), and has sometimes worked on my Mac with System 7.0.  It is highly unlikely that it will work with older systems (pre 6.0 anyway) or with the 64k ROM.  It might work with the other models, but I don't have them all, so I don't know (Anyone want to give me a IIfx (or one of those new beasts?  How did they come up with such a terrible name???) so I can check for compatibility?).  It might work with future versions of MacTCP (after 1.1), but who can tell?  If it works on your system (or especially if it doesn't!), send me a postcard or some Email and let me know!
  97.  
  98. Ñ Fine Print
  99.  
  100.       Peter Lewis hereby disclaims all warranties relating to this software, whether express or implied, including without limitation any implied warranties of merchantability or fitness for a particular purpose.  Does any one really read this stuff.  Peter Lewis will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason, even if Peter Lewis or an agent of his has been advised of the possibility of such damages.  In no event shall Peter Lewis be liable for any damages, regardless of the form of the claim.  The person using the software bears all risk as to the quality and performance of the software.
  101.  
  102. Ñ Version History
  103.  
  104. Still to do -
  105.  
  106. Word wrapping lines.
  107. Perhaps a password facility.
  108.  
  109. v1.0.0
  110. ~Moved strings into resource fork.
  111. ~Improved strings
  112.  
  113. Ñ The Author
  114.  
  115. Other programs also written by me:
  116. DeHQX 2.0.0 - BinHex decoder
  117. Finger 1.3.5 - Macintosh Finger client/daemon
  118. Talk 1.0.6 - Macintosh Talk client/daemon
  119.  
  120. Send postcards, comments, bug reports, and wishes to:
  121.  
  122. Peter Lewis,
  123. 10 Earlston Way,
  124. Booragoon, WA, 6154,
  125. AUSTRALIA
  126.  
  127. or by electronic mail to:
  128.  
  129. Internet: peter@cujo.curtin.edu.au
  130. Bitnet: peter%cujo.curtin.edu.au@cunyvm.bitnet
  131. UUCP: uunet!munnari.oz!cujo.curtin.edu.au!peter
  132.